﻿#ifndef _OSS_LIST_H
#define _OSS_LIST_H
#include "ossType.h"

OSS_EXTERN_BEG

#define LIST_POISON1  0//((void *) 0x00100100)
#define LIST_POISON2  0//((void *) 0x00200200)
/*
 * Simple doubly linked list implementation.
 *
 * Some of the internal functions ("__xxx") are useful when
 * manipulating whole lists rather than single entries, as
 * sometimes we already know the next/prev entries and we can
 * generate better code by using them directly rather than
 * using the generic single-entry routines.
 */

typedef struct list_head {
	struct list_head *next, *prev;
	list_head();
}OssListNode,*OssPListNode;

#define OSS_LIST_HEAD_INIT(name) { &(name), &(name) }

#define OSS_LIST_HEAD(name) \
	struct list_head name = OSS_LIST_HEAD_INIT(name)


void OSS_INIT_LIST_HEAD(struct list_head *list);

/*
#define INIT_LIST_HEAD(list) (list->next = list,list->prev = list)
*/




/**
 * list_add - add a new entry
 * @new: new entry to be added
 * @head: list head to add it after
 *
 * Insert a new entry after the specified head.
 * This is good for implementing stacks.
 */
void OssListAdd(struct list_head *newNode, struct list_head *head);


/**
 * list_add_tail - add a new entry
 * @new: new entry to be added
 * @head: list head to add it before
 *
 * Insert a new entry before the specified head.
 * This is useful for implementing queues.
 */
void OssListAddTail(struct list_head *newNode, struct list_head *head);




void OssListDel(struct list_head *entry);

//void OssListRemoveFirstEntry(struct list_head* entry)


/**
 * list_replace - replace old entry by new one
 * @old : the element to be replaced
 * @new : the new element to insert
 *
 * If @old was empty, it will be overwritten.
 */
void OssListReplace(struct list_head *old,
				struct list_head *newNode);

void OssListReplaceInit(struct list_head *old,
					struct list_head *newNode);

/**
 * list_del_init - deletes entry from list and reinitialize it.
 * @entry: the element to delete from the list.
 */
void OssListDelInit(struct list_head *entry);

/**
 * list_move - delete from one list and add as another's head
 * @list: the entry to move
 * @head: the head that will precede our entry
 */
void OssListMove(struct list_head *list, struct list_head *head);

/**
 * list_move_tail - delete from one list and add as another's tail
 * @list: the entry to move
 * @head: the head that will follow our entry
 */
void OssListMoveTail(struct list_head *list,
				  struct list_head *head);

/**
 * list_is_last - tests whether @list is the last entry in list @head
 * @list: the entry to test
 * @head: the head of the list
 */
int OssListIsLast(const struct list_head *list,
				const struct list_head *head);

/**
 * list_empty - tests whether a list is empty
 * @head: the list to test.
 */
int OssListEmpty(const struct list_head *head);

/**
 * list_empty_careful - tests whether a list is empty and not being modified
 * @head: the list to test
 *
 * Description:
 * tests whether a list is empty _and_ checks that no other CPU might be
 * in the process of modifying either member (next or prev)
 *
 * NOTE: using list_empty_careful() without synchronization
 * can only be safe if the only activity that can happen
 * to the list entry is list_del_init(). Eg. it cannot be used
 * if another CPU could re-list_add() it.
 */
int OssListEmptyCareful(const struct list_head *head);

/**
 * list_is_singular - tests whether a list has just one entry.
 * @head: the list to test.
 */
int OssListIsSingular(const struct list_head *head);


/**
 * list_cut_position - cut a list into two
 * @list: a new list to add all removed entries
 * @head: a list with entries
 * @entry: an entry within head, could be the head itself
 *	and if so we won't cut the list
 *
 * This helper moves the initial part of @head, up to and
 * including @entry, from @head to @list. You should
 * pass on @entry an element you know is on @head. @list
 * should be an empty list or a list you do not care about
 * losing its data.
 *
 */
void OssListCutPosition(struct list_head *list,
		struct list_head *head, struct list_head *entry);


/**
 * list_splice - join two lists, this is designed for stacks
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 */
void OssListSplice(struct list_head *list,
				struct list_head *head);

/**
 * list_splice_tail - join two lists, each list being a queue
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 */
void OssListSpliceTail(struct list_head *list,
				struct list_head *head);


/**
 * list_splice_init - join two lists and reinitialise the emptied list.
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 *
 * The list at @list is reinitialised
 */
void OssListSpliceInit(struct list_head *list,
				    struct list_head *head);

/**
 * list_splice_tail_init - join two lists and reinitialise the emptied list
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 *
 * Each of the lists is a queue.
 * The list at @list is reinitialised
 */
void ListSpliceTailInit(struct list_head *list,
					 struct list_head *head);

#define OssGetListHeadEntry(ListHead)  ((ListHead)->next)

/*
 * MEMBER在结构体中的相对位置
*/
#ifndef OSSOffsetof
#define OSSOffsetof(TYPE, MEMBER) ((unsigned long long) &(((TYPE *)0)->MEMBER))
#endif
					  
#ifndef OssOffsetof
#define OssOffsetof(TYPE, MEMBER) ((unsigned long long) &(((TYPE *)0)->MEMBER))
#endif

/**
 * container_of - cast a member of a structure out to the containing structure
 * @ptr:    the pointer to the member.
 * @type:   the type of the container struct this is embedded in.
 * @member: the name of the member within the struct.
 *
 */
#define OssContainerOf(ptr, type, member) ((type *)(((char*)((OssListNode*)ptr)) - OSSOffsetof(type, member)))

/**
 * list_entry - get the struct for this entry
 * @ptr:	the &struct list_head pointer.
 * @type:	the type of the struct this is embedded in.
 * @member:	the name of the list_struct within the struct.
 */
#define OssListEntry(ptr, type, member) \
	OssContainerOf(ptr, type, member)

/**
 * list_first_entry - get the first element from a list
 * @ptr:	the list head to take the element from.
 * @type:	the type of the struct this is embedded in.
 * @member:	the name of the list_struct within the struct.
 *
 * Note, that list is expected to be not empty.
 */
#define OssListFirstEntry(ptr, type, member) \
	OssListEntry((ptr)->next, type, member)

/**
 *		获取最后一个元素
 */
#define OssListLastEntry(ptr, type, member) \
	OssListEntry((ptr)->prev, type, member)

/**
 * list_for_each	-	iterate over a list
 * @pos:	the &struct list_head to use as a loop cursor.
 * @head:	the head for your list.
 *		链表自己向后遍历
 */
#define ListForEach(pos, head) \
	for (pos = (head)->next; /*prefetch(pos->next),*/ pos != (head); \
        	pos = pos->next)

/**
 * __list_for_each	-	iterate over a list
 * @pos:	the &struct list_head to use as a loop cursor.
 * @head:	the head for your list.
 *
 * This variant differs from list_for_each() in that it's the
 * simplest possible list iteration code, no prefetching is done.
 * Use this for code that knows the list to be very short (empty
 * or 1 entry) most of the time.
 *	链表自己向后遍历
 */
#define oss_list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

/**
 * list_for_each_prev	-	iterate over a list backwards
 * @pos:	the &struct list_head to use as a loop cursor.
 * @head:	the head for your list.
 *	链表自己逆向遍历
 */
#define OssListForEachPrev(pos, head) \
	for (pos = (head)->prev; /*prefetch(pos->prev),*/ pos != (head); \
        	pos = pos->prev)

/**
 * list_for_each_safe - iterate over a list safe against removal of list entry
 * @pos:	the &struct list_head to use as a loop cursor.
 * @n:		another &struct list_head to use as temporary storage
 * @head:	the head for your list.
 *		链表自己先后遍历
 */
#define OssListForEachSafe(pos, n, head) \
	for (pos = (head)->next, n = pos->next; pos != (head); \
		pos = n, n = pos->next)

/**
 * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
 * @pos:	the &struct list_head to use as a loop cursor.
 * @n:		another &struct list_head to use as temporary storage
 * @head:	the head for your list.
 *		链表自己逆向遍历
 */
#define OssListForEachPrevSafe(pos, n, head) \
	for (pos = (head)->prev, n = pos->prev; \
	     /*prefetch(pos->prev),*/ pos != (head); \
	     pos = n, n = pos->prev)

/**
 * list_for_each_entry	-	iterate over list of given type
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *	从头元素的下一个开始，先后遍历
 */
#define OssListForEachEntry(pos, head, member,type)				\
	for (pos = OssListEntry((head)->next, type, member);	\
	     /*prefetch(pos->member.next),*/ &pos->member != (head); 	\
	     pos = OssListEntry(pos->member.next, type, member))

/**
 * list_for_each_entry_reverse - iterate backwards over list of given type.
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 * 从最后一个元素开始，先前遍历
 */
#define OssListForEachEntryReverse(pos, head, member,type)			\
	for (pos = OssListEntry((head)->prev, type, member);	\
	     /*prefetch(pos->member.prev),*/ &pos->member != (head); 	\
	     pos = OssListEntry(pos->member.prev, type, member))

/**
 * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
 * @pos:	the type * to use as a start point
 * @head:	the head of the list
 * @member:	the name of the list_struct within the struct.
 *
 * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
 */
//???????????????????????????????????????????????????????
#define OssListPrepareEntry(pos, head, member,type) \
	((pos) ? : OssListEntry(head, type, member))

/**
 * list_for_each_entry_continue - continue iteration over list of given type
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Continue to iterate over list of given type, continuing after
 * the current position.
 *	从当前位置的下一个开始，先后遍历
 */
#define OssListForEachEntryContinue(pos, head, member,type) 		\
	for (pos = OssListEntry(pos->member.next, type, member);	\
	      /*prefetch(pos->member.next),*/ &pos->member != (head); 	\
	     pos = OssListEntry(pos->member.next, type, member))

/**
 * list_for_each_entry_continue_reverse - iterate backwards from the given point
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Start to iterate over list of given type backwards, continuing after
 * the current position.
 *		从当前位置的前一个开始，向前遍历
 */
#define OssListForEachEntryContinueReverse(pos, head, member,type)		\
	for (pos = OssListEntry(pos->member.prev, type, member);	\
	     /*prefetch(pos->member.prev), */&pos->member != (head);	\
	     pos = OssListEntry(pos->member.prev, type, member))

/**
 * list_for_each_entry_from - iterate over list of given type from the current point
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Iterate over list of given type, continuing from current position.
 *		从当前位置开始遍历
 */
#define OssListForEachEntryFrom(pos, head, member,type) 			\
	for (;  &pos->member != (head);	\
	     pos = OssListEntry(pos->member.next, type, member))

/**
 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
 * @pos:	the type * to use as a loop cursor.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *	从第一个的下一个开始遍历，忽略第一个元素
 */
#define OssListForEachEntrySafe(pos, n, head, member,type)			\
	for (pos = OssListEntry((head)->next, type, member),	\
		n = OssListEntry(pos->member.next, type, member);	\
	     &pos->member != (head); 					\
	     pos = n, n = OssListEntry(n->member.next,type, member))

/**
 * list_for_each_entry_safe_continue
 * @pos:	the type * to use as a loop cursor.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Iterate over list of given type, continuing after current point,
 * safe against removal of list entry.
 *	从当前位置的下一个开始遍历
 */
#define OssListForEachEntrySafeContinue(pos, n, head, member,type) 		\
	for (pos = OssListEntry(pos->member.next, type, member), 		\
		n = OssListEntry(pos->member.next, type, member);		\
	     &pos->member != (head);						\
	     pos = n, n = OssListEntry(n->member.next, type, member))

/**
 * list_for_each_entry_safe_from
 * @pos:	the type * to use as a loop cursor.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Iterate over list of given type from current point, safe against
 * removal of list entry.
 *	从pos位置开始遍历
 */
#define OssListForEachEntrySafeFrom(pos, n, head, member,type) 			\
	for (n = OssListEntry(pos->member.next, type, member);		\
	     &pos->member != (head);						\
	     pos = n, n = OssListEntry(n->member.next, type, member))

/**
 * list_for_each_entry_safe_reverse
 * @pos:	the type * to use as a loop cursor.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 *
 * Iterate backwards over list of given type, safe against removal
 * of list entry.
 *		倒序遍历
 *@pos	可以不赋初值
 *@n	可以不赋初值
 */
#define OssListForEachEntrySafeReverse(pos, n, head, member,type)		\
	for (pos = OssListEntry((head)->prev, type, member),	\
		n = OssListEntry(pos->member.prev, type, member);	\
	     &pos->member != (head); 					\
	     pos = n, n = OssListEntry(n->member.prev, type, member))


#define OssListForEachEntrySafeContinueReverse(pos, n, head, member,type)		\
	for (n = OssListEntry(pos->member.prev, type, member);	\
	     &pos->member != (head); 					\
	     pos = n, n = OssListEntry(n->member.prev, type, member))


/**
 *		初始化元素
 */
#define	OSS_INIT_ITEM(item,listnode,type)	\
	memset(&(item),0,sizeof(type));		\
	(item).listnode.next = &(item).listnode;	\
	(item).listnode.prev = &(item).listnode;

//////////////////////////////////////////////////////////////////////////
//2012年1月19日 新增
#define DEC_LIST(var)	OssListNode m_##var;\
	Handle	 m_##var##Event;

OSS_EXTERN_END
#endif
